home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / g_man / cat3 / ftn / readpi.z / readpi
Encoding:
Text File  |  2002-10-03  |  4.0 KB  |  133 lines
  1.  
  2.  
  3.  
  4. rrrreeeeaaaaddddppppiiii((((3333GGGG))))                                                          rrrreeeeaaaaddddppppiiii((((3333GGGG))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      rrrreeeeaaaaddddppppiiii - returns values of specific pixels
  10.  
  11. FFFFOOOORRRRTTTTRRRRAAAANNNN SSSSPPPPEEEECCCCIIIIFFFFIIIICCCCAAAATTTTIIIIOOOONNNN
  12.      iiiinnnntttteeeeggggeeeerrrr****4444 ffffuuuunnnnccccttttiiiioooonnnn rrrreeeeaaaaddddppppiiii((((nnnn,,,, ccccoooolllloooorrrrssss))))
  13.      iiiinnnntttteeeeggggeeeerrrr****4444 nnnn
  14.      iiiinnnntttteeeeggggeeeerrrr****2222 ccccoooolllloooorrrrssss((((nnnn))))
  15.  
  16. PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRRSSSS
  17.      _n        expects the number of pixels to be read by the function.
  18.  
  19.      _c_o_l_o_r_s   expects the array in which the pixel values are to be stored.
  20.  
  21. FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN RRRREEEETTTTUUUURRRRNNNN VVVVAAAALLLLUUUUEEEE
  22.      The returned value of this function is the number of pixels actually
  23.      read.  A returned function value of 0 indicates an error, that the
  24.      starting point is not a valid character position.
  25.  
  26. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  27.      rrrreeeeaaaaddddppppiiii attempts to read up to _n pixel values from the bitplanes in color
  28.      map mode.  It reads them into the array _c_o_l_o_r_s starting from the current
  29.      character position along a single scan line (constant _y) in the direction
  30.      of increasing _x.  rrrreeeeaaaaddddppppiiii returns the number of pixels read, which is the
  31.      number requested if the starting point is a valid character position
  32.      (inside the current viewport).  rrrreeeeaaaaddddppppiiii returns zero if the starting point
  33.      is not a valid character position. The values of pixels read outside the
  34.      viewport or the screen are undefined.  rrrreeeeaaaaddddppppiiii updates the current
  35.      character position to one pixel to the right of the last one read; the
  36.      current character position is undefined if the new position is outside
  37.      the viewport.
  38.  
  39.      In double buffer mode, only the back buffer is read by default. On
  40.      machines that support it, you can use rrrreeeeaaaaddddssssoooo to control which buffer is
  41.      read.
  42.  
  43.      The system must be in color map mode for rrrreeeeaaaaddddppppiiii to function correctly.
  44.  
  45. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  46.      lrectr, readso
  47.  
  48. NNNNOOOOTTTTEEEESSSS
  49.      rrrreeeeaaaaddddppppiiii should not be used in new development.  Rather, pixels should be
  50.      read using the high-performance llllrrrreeeeccccttttrrrr command.
  51.  
  52.      This routine is available only in immediate mode.
  53.  
  54.      The upper bits of a color value (an element of the _c_o_l_o_r_s array) are
  55.      undefined.  You can write this information to the frame buffer without
  56.      problems.  However, if you intend to interpret this data, be sure you
  57.      mask out the upper bits.
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. rrrreeeeaaaaddddppppiiii((((3333GGGG))))                                                          rrrreeeeaaaaddddppppiiii((((3333GGGG))))
  71.  
  72.  
  73.  
  74. BBBBUUUUGGGGSSSS
  75.      On IRIS-4D GT and GTX models, when reading pixels from the PUPMODE
  76.      planes, the returned bits are shifted up by two bits.
  77.  
  78.  
  79.  
  80.  
  81.  
  82.  
  83.  
  84.  
  85.  
  86.  
  87.  
  88.  
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.